/*
 * Copyright 2021 Shulie Technology, Co.Ltd
 * Email: shulie@shulie.io
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.shulie.surge.data.runtime.disruptor;

/**
 * EventProcessors waitFor events to become available for consumption from the {@link RingBuffer}
 *
 * An EventProcessor will generally be associated with a Thread for execution.
 */
public interface EventProcessor extends Runnable
{
	/**
	 * Get a reference to the {@link Sequence} being used by this {@link EventProcessor}.
	 *
	 * @return reference to the {@link Sequence} for this {@link EventProcessor}
	 */
	Sequence getSequence();

	/**
	 * Signal that this EventProcessor should stop when it has finished consuming at the next clean break.
	 * It will call {@link SequenceBarrier#alert()} to notify the thread to check status.
	 */
	void halt();

	boolean isRunning();
}
